<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>     JavaDoc for multipleDeploymentAllowed(), modifiesCas() and outputsNewCases() is duplicated from<a name="line.19"></a>
<FONT color="green">020</FONT>     org.apache.uima.resource.metadata.OperationalProperties for sake of the users' convenience. The<a name="line.20"></a>
<FONT color="green">021</FONT>     copied JavaDoc is licensed as under the Apache 2.0 license as well. No particular author<a name="line.21"></a>
<FONT color="green">022</FONT>     attribution was given in the original source file.<a name="line.22"></a>
<FONT color="green">023</FONT>     */<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    package org.uimafit.descriptor;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    import java.lang.annotation.ElementType;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.lang.annotation.Retention;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.lang.annotation.RetentionPolicy;<a name="line.29"></a>
<FONT color="green">030</FONT>    import java.lang.annotation.Target;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.analysis_engine.AnalysisEngine;<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>    /**<a name="line.34"></a>
<FONT color="green">035</FONT>     * Control aspects of the UIMA analysis component.&lt;br/&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * <a name="line.36"></a>
<FONT color="green">037</FONT>     * @author Richard Eckart de Castilho<a name="line.37"></a>
<FONT color="green">038</FONT>     */<a name="line.38"></a>
<FONT color="green">039</FONT>    @Retention(RetentionPolicy.RUNTIME)<a name="line.39"></a>
<FONT color="green">040</FONT>    @Target(ElementType.TYPE)<a name="line.40"></a>
<FONT color="green">041</FONT>    public @interface OperationalProperties {<a name="line.41"></a>
<FONT color="green">042</FONT>            /**<a name="line.42"></a>
<FONT color="green">043</FONT>             * the default value for multipleDeploymentAllowed if none is given.<a name="line.43"></a>
<FONT color="green">044</FONT>             */<a name="line.44"></a>
<FONT color="green">045</FONT>            public static final boolean MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT = true;<a name="line.45"></a>
<FONT color="green">046</FONT>            /**<a name="line.46"></a>
<FONT color="green">047</FONT>             * the default value for modifiesCas if none is given<a name="line.47"></a>
<FONT color="green">048</FONT>             */<a name="line.48"></a>
<FONT color="green">049</FONT>            public static final boolean MODIFIES_CAS_DEFAULT = true;<a name="line.49"></a>
<FONT color="green">050</FONT>            /**<a name="line.50"></a>
<FONT color="green">051</FONT>             * the default value for outputsNewCases if none is given<a name="line.51"></a>
<FONT color="green">052</FONT>             */<a name="line.52"></a>
<FONT color="green">053</FONT>            public static final boolean OUTPUTS_NEW_CASES_DEFAULT = false;<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>            /**<a name="line.55"></a>
<FONT color="green">056</FONT>             * Gets whether multiple instances of this component can be run in parallel, each receiving a<a name="line.56"></a>
<FONT color="green">057</FONT>             * subset of the documents from a collection.<a name="line.57"></a>
<FONT color="green">058</FONT>             * <a name="line.58"></a>
<FONT color="green">059</FONT>             * @return true if multiple instances can be run in parallel, false if not<a name="line.59"></a>
<FONT color="green">060</FONT>             * @see org.apache.uima.resource.metadata.OperationalProperties#isMultipleDeploymentAllowed()<a name="line.60"></a>
<FONT color="green">061</FONT>             */<a name="line.61"></a>
<FONT color="green">062</FONT>            boolean multipleDeploymentAllowed() default MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT;<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>            /**<a name="line.64"></a>
<FONT color="green">065</FONT>             * Gets whether this component will modify the CAS.<a name="line.65"></a>
<FONT color="green">066</FONT>             * <a name="line.66"></a>
<FONT color="green">067</FONT>             * @return true if this component modifies the CAS, false if it does not.<a name="line.67"></a>
<FONT color="green">068</FONT>             * @see org.apache.uima.resource.metadata.OperationalProperties#getModifiesCas()<a name="line.68"></a>
<FONT color="green">069</FONT>             */<a name="line.69"></a>
<FONT color="green">070</FONT>            boolean modifiesCas() default MODIFIES_CAS_DEFAULT;<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>            /**<a name="line.72"></a>
<FONT color="green">073</FONT>             * Gets whether this AnalysisEngine may output new CASes. If this property is set to true, an<a name="line.73"></a>
<FONT color="green">074</FONT>             * application can use the<a name="line.74"></a>
<FONT color="green">075</FONT>             * {@link AnalysisEngine#processAndOutputNewCASes(org.apache.uima.cas.CAS)} to pass a CAS to<a name="line.75"></a>
<FONT color="green">076</FONT>             * this this AnalysisEngine and then step through all of the output CASes that it produces. For<a name="line.76"></a>
<FONT color="green">077</FONT>             * example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a<a name="line.77"></a>
<FONT color="green">078</FONT>             * separate CAS.<a name="line.78"></a>
<FONT color="green">079</FONT>             * <a name="line.79"></a>
<FONT color="green">080</FONT>             * @return true if this component may output new CASes, false if it does not<a name="line.80"></a>
<FONT color="green">081</FONT>             * @see org.apache.uima.resource.metadata.OperationalProperties#getOutputsNewCASes()<a name="line.81"></a>
<FONT color="green">082</FONT>             */<a name="line.82"></a>
<FONT color="green">083</FONT>            boolean outputsNewCases() default OUTPUTS_NEW_CASES_DEFAULT;<a name="line.83"></a>
<FONT color="green">084</FONT>    }<a name="line.84"></a>




























































</PRE>
</BODY>
</HTML>
